<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>pybindgen.enum.Enum</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="pybindgen-module.html">Package&nbsp;pybindgen</a> ::
        <a href="pybindgen.enum-module.html">Module&nbsp;enum</a> ::
        Class&nbsp;Enum
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="pybindgen.enum.Enum-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Enum</h1><p class="nomargin-top"><span class="codelink"><a href="pybindgen.enum-pysrc.html#Enum">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_pybindge_47" name="uml_class_diagram_for_pybindge_47">
<area shape="rect" href="pybindgen.enum.Enum-class.html#module" title="Get the Module object this class belongs to" alt="" coords="17,28,529,47"/>
<area shape="rect" href="pybindgen.enum.Enum-class.html#__init__" title="Creates a new enum wrapper, which should be added to a module with &#160;module.add_enum()." alt="" coords="17,49,529,68"/>
<area shape="rect" href="pybindgen.enum.Enum-class.html#get_module" title="Get the Module object this class belongs to" alt="" coords="17,68,529,87"/>
<area shape="rect" href="pybindgen.enum.Enum-class.html#set_module" title="Set the Module object this class belongs to; can only be set once" alt="" coords="17,87,529,105"/>
<area shape="rect" href="pybindgen.enum.Enum-class.html#generate" title="pybindgen.enum.Enum.generate" alt="" coords="17,105,529,124"/>
<area shape="rect" href="pybindgen.enum.Enum-class.html#generate_declaration" title="pybindgen.enum.Enum.generate_declaration" alt="" coords="17,124,529,143"/>
<area shape="rect" href="pybindgen.enum.Enum-class.html" title="Class that adds support for a C/C++ enum type" alt="" coords="16,11,531,144"/>
</map>
  <img src="uml_class_diagram_for_pybindge_47.gif" alt='' usemap="#uml_class_diagram_for_pybindge_47" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Class that adds support for a C/C++ enum type</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="pybindgen.enum.Enum-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>,
        <span class="summary-sig-arg">values</span>,
        <span class="summary-sig-arg">values_prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">cpp_namespace</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">outer_class</span>=<span class="summary-sig-default">None</span>)</span><br />
      Creates a new enum wrapper, which should be added to a module with 
      module.add_enum().</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.enum-pysrc.html#Enum.__init__">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___39-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for___init___39-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for___init___39" name="call_graph_for___init___39">
<area shape="rect" href="pybindgen.enum.Enum-class.html#__init__" title="__init__()" alt="" coords="375,5,479,37"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#add_enum" title="module.ModuleBase.add_enum()" alt="" coords="5,5,325,37"/>
</map>
  <img src="call_graph_for___init___39.gif" alt='' usemap="#call_graph_for___init___39" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="get_module"></a><span class="summary-sig-name">get_module</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Get the Module object this class belongs to</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.enum-pysrc.html#Enum.get_module">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_get_module_3-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_get_module_3-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_get_module_3" name="call_graph_for_get_module_3">
<area shape="rect" href="pybindgen.enum.Enum-class.html#generate" title="generate()" alt="" coords="7,5,124,37"/>
<area shape="rect" href="pybindgen.enum.Enum-class.html#get_module" title="get_module()" alt="" coords="175,5,316,37"/>
</map>
  <img src="call_graph_for_get_module_3.gif" alt='' usemap="#call_graph_for_get_module_3" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="set_module"></a><span class="summary-sig-name">set_module</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">module</span>)</span><br />
      Set the Module object this class belongs to; can only be set once</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.enum-pysrc.html#Enum.set_module">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_set_module_3-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_set_module_3-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_set_module_3" name="call_graph_for_set_module_3">
<area shape="rect" href="pybindgen.enum.Enum-class.html#set_module" title="set_module()" alt="" coords="423,61,561,93"/>
<area shape="rect" href="pybindgen.typehandlers.base.Parameter.__metaclass__-class.html#__init__" title="typehandlers.base.Parameter.__metaclass__.__init__()" alt="" coords="621,5,1136,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.ReturnValue.__metaclass__-class.html#__init__" title="typehandlers.base.ReturnValue.__metaclass__.__init__()" alt="" coords="611,61,1147,93"/>
<area shape="rect" href="pybindgen.typehandlers.base.TypeMatcher-class.html#register" title="typehandlers.base.TypeMatcher.register()" alt="" coords="679,117,1079,149"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#_add_enum_obj" title="module.ModuleBase._add_enum_obj()" alt="" coords="7,61,372,93"/>
</map>
  <img src="call_graph_for_set_module_3.gif" alt='' usemap="#call_graph_for_set_module_3" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="generate"></a><span class="summary-sig-name">generate</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">unused_code_sink</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.enum-pysrc.html#Enum.generate">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_generate_21-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_generate_21-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_generate_21" name="call_graph_for_generate_21">
<area shape="rect" href="pybindgen.enum.Enum-class.html#generate" title="generate()" alt="" coords="396,89,513,121"/>
<area shape="rect" href="pybindgen.enum.Enum-class.html#get_module" title="get_module()" alt="" coords="699,5,840,37"/>
<area shape="rect" href="pybindgen.typehandlers.base.CodeBlock-class.html#indent" title="typehandlers.base.CodeBlock.indent()" alt="" coords="585,61,953,93"/>
<area shape="rect" href="pybindgen.typehandlers.base.CodeBlock-class.html#unindent" title="typehandlers.base.CodeBlock.unindent()" alt="" coords="573,117,965,149"/>
<area shape="rect" href="pybindgen.typehandlers.base.CodeBlock-class.html#write_code" title="typehandlers.base.CodeBlock.write_code()" alt="" coords="564,173,975,205"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#do_generate" title="module.ModuleBase.do_generate()" alt="" coords="7,89,345,121"/>
</map>
  <img src="call_graph_for_generate_21.gif" alt='' usemap="#call_graph_for_generate_21" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="generate_declaration"></a><span class="summary-sig-name">generate_declaration</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">sink</span>,
        <span class="summary-sig-arg">module</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="pybindgen.enum-pysrc.html#Enum.generate_declaration">source&nbsp;code</a></span>
            <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for_generate_declar_4-summary-div');return false;">call&nbsp;graph</a></span>&nbsp;
          </td>
        </tr>
      </table>
      <div style="display:none" id="call_graph_for_generate_declar_4-summary-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for_generate_declar_4" name="call_graph_for_generate_declar_4">
<area shape="rect" href="pybindgen.enum.Enum-class.html#generate_declaration" title="generate_declaration()" alt="" coords="396,5,625,37"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#do_generate" title="module.ModuleBase.do_generate()" alt="" coords="7,5,345,37"/>
</map>
  <img src="call_graph_for_generate_declar_4.gif" alt='' usemap="#call_graph_for_generate_declar_4" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__str__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Properties</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="pybindgen.enum.Enum-class.html#module" class="summary-name">module</a><br />
      Get the Module object this class belongs to
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>,
        <span class="sig-arg">values</span>,
        <span class="sig-arg">values_prefix</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">cpp_namespace</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">outer_class</span>=<span class="sig-default">None</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="pybindgen.enum-pysrc.html#Enum.__init__">source&nbsp;code</a></span>&nbsp;
    <br /><span class="codelink"><a href="javascript:void(0);" onclick="toggleCallGraph('call_graph_for___init___39-div');return false;">call&nbsp;graph</a></span>&nbsp;</td>
  </tr></table>
  <div style="display:none" id="call_graph_for___init___39-div"><center>
<table border="0" cellpadding="0" cellspacing="0">
  <tr><td><center>  <map id="call_graph_for___init___39" name="call_graph_for___init___39">
<area shape="rect" href="pybindgen.enum.Enum-class.html#__init__" title="__init__()" alt="" coords="375,5,479,37"/>
<area shape="rect" href="pybindgen.module.ModuleBase-class.html#add_enum" title="module.ModuleBase.add_enum()" alt="" coords="5,5,325,37"/>
</map>
  <img src="call_graph_for___init___39.gif" alt='' usemap="#call_graph_for___init___39" ismap="ismap" class="graph-without-title" />
</center></td></tr>
  <tr><th>Call Graph</th></tr>
</table><br />
</center></div>

  <p>Creates a new enum wrapper, which should be added to a module with 
  module.add_enum().</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>name</code></strong> - C name of the enum type</li>
        <li><strong class="pname"><code>values</code></strong> - a list of strings with all enumeration value names, or list of 
          (name, C-value-expr) tuples.</li>
        <li><strong class="pname"><code>values_prefix</code></strong> - prefix to add to value names, or None</li>
        <li><strong class="pname"><code>cpp_namespace</code></strong> - optional C++ namespace identifier, or None. Note: this namespace 
          is *in addition to* whatever namespace of the module the enum 
          belongs to.  Typically this parameter is to be used when wrapping
          enums declared inside C++ classes.</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Property Details</span></td>
</tr>
</table>
<a name="module"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">module</h3>
  <p>Get the Module object this class belongs to</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="pybindgen.enum.Enum-class.html#get_module" class="summary-sig-name">get_module</a>(<span class="summary-sig-arg">self</span>)</span>
        - Get the Module object this class belongs to
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><a href="pybindgen.enum.Enum-class.html#set_module" class="summary-sig-name">set_module</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">module</span>)</span>
        - Set the Module object this class belongs to; can only be set once
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="pybindgen-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Jul 12 17:23:21 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
